<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!--

    Licensed to the Apache Software Foundation (ASF) under one
    or more contributor license agreements.  See the NOTICE file
    distributed with this work for additional information
    regarding copyright ownership.  The ASF licenses this file
    to you under the Apache License, Version 2.0 (the
    "License"); you may not use this file except in compliance
    with the License.  You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing,
    software distributed under the License is distributed on an
    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    KIND, either express or implied.  See the License for the
    specific language governing permissions and limitations
    under the License.

-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
<head>
<title>Standard Web Project Properties Dialog Box: Documenting</title>
<link rel="stylesheet" href="ide.css" title="Oracle BLAFDoc" type="text/css"/>
</head>

<body>
<p><a id="CHDCFHBI" name="CHDCFHBI"></a><a id="org.netbeans.modules.web.project.ui.customizer.CustomizerJavadoc" name="org.netbeans.modules.web.project.ui.customizer.CustomizerJavadoc"></a></p>
<div id="NBCSH3962"><!-- infolevel="all" infotype="General" -->
<h1>Standard Web Project Properties Dialog Box: Documenting</h1>
<a name="BEGIN" id="BEGIN"></a>
<p>Use to configure how the IDE generates Javadoc documentation for your classes, by setting the following properties. 
<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer">
<param name="content" value="http://www.oracle.com/pls/topic/lookup?ctx=nb8200&id=NBDAG2110">
<param name="text" value="<html><u>How?</u></html>">
<param name="textFontSize" value="medium">
<param name="textColor" value="blue">
</object>
</p>

<table summary="User interface elements and descriptions" dir="ltr" border="1" width="100%" frame="hsides" rules="groups" cellpadding="3" cellspacing="0">
<col width="24%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t33">Property</th>
<th align="left" valign="bottom" id="r1c2-t33">Description</th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t33" headers="r1c1-t33">
<p>Include Private and Private Package Members</p>
</td>
<td align="left" headers="r2c1-t33 r1c2-t33">Select to generate Javadoc that includes all private and private package members.</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t33" headers="r1c1-t33">
<p>Generate</p>
</td>
<td align="left" headers="r3c1-t33 r1c2-t33">Select any of the listed below options to have them passed as parameters into the JavaDoc.</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r4c1-t33" headers="r1c1-t33">
<p>&nbsp;&nbsp;&nbsp;&nbsp;Class Hierarchy Tree</p>
</td>
<td align="left" headers="r4c1-t33 r1c2-t33">Choose to have the class hierarchy documented.</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r5c1-t33" headers="r1c1-t33">
<p>&nbsp;&nbsp;&nbsp;&nbsp;Class and Package Usage Pages</p>
</td>
<td align="left" headers="r5c1-t33 r1c2-t33">Choose to have the use of class and package documented.</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r6c1-t33" headers="r1c1-t33">
<p>&nbsp;&nbsp;&nbsp;&nbsp;Navigation Bar</p>
</td>
<td align="left" headers="r6c1-t33 r1c2-t33">Choose to have the navigator bar generated.</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r7c1-t33" headers="r1c1-t33">
<p>&nbsp;&nbsp;&nbsp;&nbsp;Index</p>
</td>
<td align="left" headers="r7c1-t33 r1c2-t33">Choose to have the documentation index generated.</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r8c1-t33" headers="r1c1-t33">
<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Separate Index per Letter</p>
</td>
<td align="left" headers="r8c1-t33 r1c2-t33">Choose to have a separate index file for each letter generated. The option is available only if the Index checkbox is selected.</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r9c1-t33" headers="r1c1-t33">Document Additional Tags</td>
<td align="left" headers="r9c1-t33 r1c2-t33">Select any of the listed below options to have them documented in the JavaDoc.</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r10c1-t33" headers="r1c1-t33">
<p>&nbsp;&nbsp;&nbsp;&nbsp;@author</p>
</td>
<td align="left" headers="r10c1-t33 r1c2-t33">Select to have the @author paragraphs included into JavaDoc.</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r11c1-t33" headers="r1c1-t33">
<p>&nbsp;&nbsp;&nbsp;&nbsp;@version</p>
</td>
<td align="left" headers="r11c1-t33 r1c2-t33">Select to have the @version paragraphs included into JavaDoc.</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r12c1-t33" headers="r1c1-t33">
<p>Browser Window Title</p>
</td>
<td align="left" headers="r12c1-t33 r1c2-t33">Specify the title for the browser window in which the generated JavaDoc displays.</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r13c1-t33" headers="r1c1-t33">
<p>Additional Javadoc Options</p>
</td>
<td align="left" headers="r13c1-t33 r1c2-t33">Enter additional Javadoc options as a space-separated list</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r14c1-t33" headers="r1c1-t33">Preview Generated Javadoc</td>
<td align="left" headers="r14c1-t33 r1c2-t33">Select to preview the generated JavaDoc.</td>
</tr>
</tbody>
</table>
<br />
<!-- -->
<a id="NBCSH3974" name="NBCSH3974"></a>
<hr><p><b>Related Topics</b></p>
<p><i>Developing Applications with NetBeans IDE</i>, 
<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer">
<param name="content" value="http://www.oracle.com/pls/topic/lookup?ctx=nb8200&id=NBDAG2103">
<param name="text" value="<html><u>&quot;Working with Javadoc Documentation&quot;</u></html>">
<param name="textFontSize" value="medium">
<param name="textColor" value="blue">
</object>
</p>
<p><i>Developing Applications with NetBeans IDE</i>, 
<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer">
<param name="content" value="http://www.oracle.com/pls/topic/lookup?ctx=nb8200&id=NBDAG1111">
<param name="text" value="<html><u>&quot;Configuring a Web Application&quot;</u></html>">
<param name="textFontSize" value="medium">
<param name="textColor" value="blue">
</object>
</p>

<!-- -->
<!-- Start Footer -->


<table summary="" cellspacing="0" cellpadding="0" width="100%">
<tr>
<td align="left" width="86%"><a href="legal_notice.htm">
Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements; and to You under the Apache License, Version 2.0.</a>
</td>
</tr>
</table>
<!-- -->
</body>
</html>
